[CS2113-T15-1] CLIAlgo by ong-ck · Pull Request #33 · nus-cs2113-AY2223S2/tp

ong-ck · 2023-03-02T07:14:30Z

CLIAlgo is a desktop application for managing your CS2040C notes. It is optimized to be used via a Command Line Interface (CLI). If you can type fast, you can access and sort your notes faster than ever before.

chao2048

The DG is pretty nice and clear overall!

chao2048 · 2023-03-29T04:19:13Z

+### Initializing previous saved data feature
+#### Current implementation
+
+![](.\\sequence\\diagrams\\InitializationFileManager.png "FileManager Initialization Sequence Diagram")


Is the activation bar for the FileDecoder a bit too long?

chao2048 · 2023-03-29T04:24:34Z

+### Export feature
+#### Current implementation
+
+![](.\\sequence\\diagrams\\Export.png "Export Sequence Diagram")


I think you can explain more about the part of Parser to FilterByTopicCommand to TopicManager, since they are shown on the diagram. Or perhaps it is not that important and can be ignored in the sequence diagram.

chao2048 · 2023-03-29T04:34:21Z

+Here is a class diagram of the `TopoCommand` which facilitates the storage
+function of the application.
+
+![](.\\uml\\diagrams\\TopoCommandClass.png "TopoCommand Class Diagram")


The FileManager doesn't seem to be very relevant to the class diagram, and it makes the lines crossing each other. Perhaps it doesn't have to be in this diagram.

chao2048 · 2023-03-29T04:34:28Z

+#### Current implementation
+
+![](.\\sequence\\diagrams\\InitializationFileManager.png "FileManager Initialization Sequence Diagram")
+


I think you might need an arrow back from SingleFile back to FileManager after the readFile().

GraceZhuXY

The DG is detailed and easy to read! Great job 👍

GraceZhuXY · 2023-03-30T03:11:15Z

+
+### Ui
+**API** : Ui.java
+Here is a class diagram of the `Ui` component which is responsible for handling all interactin with the User.


There seems to be a small typo here ("interactin")

GraceZhuXY · 2023-03-30T03:16:03Z

+
+The following sequence diagram shows how the Parser work.
+
+![](.\\sequence\\diagrams\\Parser.png "Parser Sequence Diagram")


The step-by-step description of the Parser is easy to understand! Perhaps the sequence diagram can also be simplified such that it is easier to comprehend together with the description (e.g. by removing return arrows, which is easy to infer)? This could also be applied to the sequence diagrams for filtering by topic operation.

GraceZhuXY · 2023-03-30T03:16:35Z

+> **Step 2**: The `parse()` method extracts out the command keyword provided by the user. It then calls the 
+> `prepareCommand()` method.
+
+> **Step 3**: The `parepareCommand()` identifies the correct `Command` object to prepare based on the command keyword.


There seems to be a small typo here ("parepareCommand()")

GraceZhuXY · 2023-03-30T03:19:58Z

-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the 
+original source as well}



I think it would be great if there was a link to your UG/a brief overview of what this app is programmed to do! It would make it easier see all the following technical details in the bigger picture.

GraceZhuXY · 2023-03-30T03:30:13Z

+Here is a class diagram of the `FileManager` which facilitates the storage
+function of the application.
+
+![](.\\uml\\diagrams\\FileManagerClass.png "FileManager Class Diagram")


I think the diagram's focus would be clearer without the Scanner and FileWriter classes, as their functions can be described using labels.

skyanzy · 2023-03-30T03:33:25Z

-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the 
+original source as well}



I think it would be better to include a table of contents and links to the headers for easier navigation

skyanzy · 2023-03-30T03:39:15Z

+
+The following sequence diagram shows how the Parser work.
+
+![](.\\sequence\\diagrams\\Parser.png "Parser Sequence Diagram")


Good job on the comprehensiveness of the diagram but the picture is unclear. maybe you can try dissecting this part into smaller sections

skyanzy · 2023-03-30T03:43:09Z

+
+The following sequence diagram shows how previously saved files are loaded into `CLIAlgo`.
+
+![](.\\sequence\\diagrams\\InitializationFileManager.png "FileManager Initialization Sequence Diagram")


i think the activation bar inside the alt block should not be broken into two parts

Sherlock-YH · 2023-03-30T05:45:52Z

May be try to modify the diagram to ensure the lines are not crossing each other

Sherlock-YH · 2023-03-30T05:52:54Z

The activation bar of [isCorrupted] should not be disconnected

namsengi11 · 2023-03-31T05:10:29Z

 ## Acknowledgements

-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the 


Should this section have links to your references?

namsengi11 · 2023-03-31T05:15:44Z

Should the AddCommand and InvalidComment be shown at the end of the diagram when a red cross deletes the instance? This applied similarly to your other sequence diagrams.

namsengi11 · 2023-03-31T05:17:50Z

Should the command class also have two blank sections for attribute and method like other classes?

namsengi11 · 2023-03-31T05:22:32Z


-1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+## Features


Should the features section be placed in the user guide instead?

Resolve issues #162, #163, #168, #169 and #171

Refactor code v2.1

…into branch-Code-Review-Fix-v2.1

…into branch-v2.0b-DG # Conflicts: # docs/sequence-diagrams/diagrams/AddFeature.png # docs/sequence-diagrams/source-files/AddFeature.puml

Add design and implementation for remove and update add sequence diagram

…ce to Ui

…into branch-PPP-v2.1

Code refactoring v2.1

Fix typos

Refactor DG and UG

…into branch-Diagrams-v2.1

Branch final edits v2.1

…into branch-Final-Refactor-v2.1

Final Refactor of UG, DG and PPP v2.1

Branch final changes v2.1

Fix Portfolio Link in AboutUs

Reformat table in AboutUs.md

Fix bug in TopoCommand

chao2048 reviewed Mar 29, 2023

View reviewed changes

GraceZhuXY reviewed Mar 30, 2023

View reviewed changes

skyanzy reviewed Mar 30, 2023

View reviewed changes

Sherlock-YH reviewed Mar 30, 2023

View reviewed changes

namsengi11 reviewed Mar 31, 2023

View reviewed changes

nicholas132000 and others added 24 commits April 3, 2023 11:22

Add design and implementation for remove and update add sequence diagram

135689c

Fix issues #169, #169, #171

5c5f20e

Hide footbox for Ui and Help seq diagrams

c1ddd95

Merge pull request #218 from nikkiDEEE/branch-PE-D-Issues-v2.0

b805720

Resolve issues #162, #163, #168, #169 and #171

Update PPP name for it to be checked by grading scripts

bc9c81f

Add break for exceptions for step 2 visualisation under Ui section in DG

808bd6e

Refactor sequence diagram spacing

7ad463b

Add printWithBox() method to Ui

fae1b49

Refactor code according to comments

0f61516

Resolve lifeline extending after object deletion

dee7818

Update names of sequence diagram

432b03d

Update sequence diagrams to remove footbox

16f574e

Merge pull request #226 from heejet/branch-refactor-code-v2.1

3ea4dfe

Refactor code v2.1

Merge branch 'master' of https://github.com/AY2223S2-CS2113-T15-1/tp …

34a2ebe

…into branch-Code-Review-Fix-v2.1

Refactor according to PR review

b13924b

Merge branch 'master' of https://github.com/AY2223S2-CS2113-T15-1/tp …

d8c03e5

…into branch-v2.0b-DG # Conflicts: # docs/sequence-diagrams/diagrams/AddFeature.png # docs/sequence-diagrams/source-files/AddFeature.puml

Refactor according to PR review

ada088a

Update DeveloperGuide.md

047dabc

Merge pull request #224 from nicholas132000/branch-v2.0b-DG

899ca5d

Add design and implementation for remove and update add sequence diagram

Fix magic keywords/numbers, move printing stuff from FilterByImportan…

1641c97

…ce to Ui

Fix whitespace issue in Ui

b1c0e76

Add: PPP

7c4ea13

Merge branch 'master' of https://github.com/AY2223S2-CS2113-T15-1/tp …

393e4a8

…into branch-PPP-v2.1

Fix: addressed code review comments

d6bc2a0

heejet and others added 30 commits April 9, 2023 15:29

Reformat DG

59d4105

Update PPP

070986a

Add page breaks to PPP

eb89f96

Merge pull request #262 from heejet/branch-code-refactoring-v2.1

8df9e92

Code refactoring v2.1

Fix typos

3c232e9

Merge pull request #263 from heejet/branch-check-documentation-v2.1

2e021da

Fix typos

Refactor DG and UG

d2cdeda

Merge pull request #264 from nicholas132000/branch-v2.0b-DG

b3881d6

Refactor DG and UG

Merge branch 'master' of https://github.com/AY2223S2-CS2113-T15-1/tp …

0898f99

…into branch-Diagrams-v2.1

Refactor UG

16c3c30

Edit PPP and add author tag

97d16f6

Update UG Command Summary table

fd6d2de

Refactor author tag

3f3cc80

Merge pull request #265 from nikkiDEEE/branch-Final-Edits-v2.1

9ea770f

Branch final edits v2.1

Refactor DG and PPP

86fd6eb

Merge branch 'master' of https://github.com/AY2223S2-CS2113-T15-1/tp …

491e4c8

…into branch-Final-Refactor-v2.1

Merge pull request #267 from ong-ck/branch-Final-Refactor-v2.1

e1abb90

Final Refactor of UG, DG and PPP v2.1

Add colon to feature title

0b66adf

Reformat DG

0f08092

Add documentation to command package

b09f40a

Add documentation to exception and file packages

e9e2f59

Add documentation to top level classes

4aacaec

Fix checkstyle violations

fd6fe9e

Merge pull request #268 from heejet/branch-final-changes-v2.1

311502a

Branch final changes v2.1

Fix portfolio link in AboutUs

0e2c0d0

Merge pull request #269 from ong-ck/branch-Final-Changes-v2.1

f9fe107

Fix Portfolio Link in AboutUs

Reformat table in AboutUs.md

2d665f4

Merge pull request #270 from heejet/branch-edit-AboutUs-v2.1

62a1db0

Reformat table in AboutUs.md

Fix bug in TopoCommand

478d276

Merge pull request #271 from heejet/branch-fix-bug-v2.1

cf0c9cd

Fix bug in TopoCommand

		#### Current implementation

		![](.\\sequence\\diagrams\\InitializationFileManager.png "FileManager Initialization Sequence Diagram")


		The following sequence diagram shows how the Parser work.

		![](.\\sequence\\diagrams\\Parser.png "Parser Sequence Diagram")

Conversation

ong-ck commented Mar 2, 2023

Uh oh!

chao2048 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GraceZhuXY left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants